Skip to main content
POST
/
customers
/
{customerId}
/
calls
cURL
curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/customers/{customerId}/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "webhook": {
    "url": "<string>",
    "secretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "requestId": "25deb7a2-ea2a-4993-8ad5-faed5367915b",
  "success": true,
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "threadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "toPhoneNumber": "+14155551234",
    "fromPhoneNumber": "+14155559876",
    "compliance": {
      "passed": true,
      "checksPassed": [
        {
          "id": "is-active",
          "name": "Is Active",
          "description": "Check if customer is active",
          "reason": "Customer is active"
        },
        {
          "id": "cease-and-desist-exclusion",
          "name": "Cease and Desist Exclusion",
          "description": "Prevent calling customers who have requested cease and desist",
          "reason": "Customer has not requested cease and desist"
        },
        {
          "id": "four-voice-call-per-day",
          "name": "Four Voice Call Per Day",
          "description": "Check if customer has had four or fewer voice calls today within the current respectful hours window",
          "reason": "Customer has had 3 voice calls today within respectful hours window (America/Los_Angeles), within the limit of 4"
        }
      ],
      "checksFailed": []
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

The agent identifier to use for the call. This will be assigned to you.

webhook
object

Webhook-related information to send the call updates to.

Response

Create call response

requestId
string<uuid>
required

The request identifier for the call.

success
boolean
required

Whether the call was successful.

data
object
required

The data for the call.